<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>E:\GitHub\WSH-Script-Tutorials\WSH 官方文档及实例\docs\Callbacks.txt.html</title>
<meta name="Generator" content="Vim/7.4">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="javascript">
<meta name="settings" content="number_lines,use_css,no_foldcolumn,expand_tabs,line_ids,prevent_copy=">
<meta name="colorscheme" content="mermaid">
<style type="text/css">
<!--
pre { font-family: monospace; color: #d4d4d4; background-color: #1e1e1e; }
body { font-family: monospace; color: #d4d4d4; background-color: #1e1e1e; }
* { font-size: 1em; }
.PreProc { color: #bf7f6f; background-color: #1e1e1e; padding-bottom: 1px; }
.Identifier { color: #569cd6; background-color: #1e1e1e; padding-bottom: 1px; }
.LineNr { color: #5a5a5a; background-color: #1e1e1e; padding-bottom: 1px; }
.Statement { color: #569cd6; background-color: #1e1e1e; padding-bottom: 1px; }
.Comment { color: #608b4e; background-color: #1e1e1e; padding-bottom: 1px; }
.Special { color: #cfbfaf; background-color: #1e1e1e; padding-bottom: 1px; }
-->
</style>

<script type='text/javascript'>
<!--

/* function to open any folds containing a jumped-to line before jumping to it */
function JumpToLine()
{
  var lineNum;
  lineNum = window.location.hash;
  lineNum = lineNum.substr(1); /* strip off '#' */

  if (lineNum.indexOf('L') == -1) {
    lineNum = 'L'+lineNum;
  }
  lineElem = document.getElementById(lineNum);
  /* Always jump to new location even if the line was hidden inside a fold, or
   * we corrected the raw number to a line ID.
   */
  if (lineElem) {
    lineElem.scrollIntoView(true);
  }
  return true;
}
if ('onhashchange' in window) {
  window.onhashchange = JumpToLine;
}

-->
</script>
</head>
<body onload='JumpToLine();'>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr">  1 </span><span class="Comment">// vi&#0058;set ft=javascript ff=dos ts=4 sts=4 sw=4 et:</span>
<span id="L2" class="LineNr">  2 </span><span class="Identifier">function</span><span class="PreProc"> on_char</span><span class="Statement">(</span><span class="Special">code</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L3" class="LineNr">  3 </span><span class="Comment">// code: UTF16 encoded char.</span>
<span id="L4" class="LineNr">  4 </span><span class="Comment">// in order to use this callback, use window.DlgCode(DLGC_WANTCHARS);</span>
<span id="L5" class="LineNr">  5 </span><span class="Comment">// see flags.txt &gt; DLGC_WANTCHARS.</span>
<span id="L6" class="LineNr">  6 </span>
<span id="L7" class="LineNr">  7 </span><span class="Identifier">function</span><span class="PreProc"> on_colors_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L8" class="LineNr">  8 </span><span class="Comment">// called when colours are changed via default UI/columns UI preferences.</span>
<span id="L9" class="LineNr">  9 </span><span class="Comment">// use window.GetColourCUI()/window.GetColorDUI() to get new colours.</span>
<span id="L10" class="LineNr"> 10 </span>
<span id="L11" class="LineNr"> 11 </span><span class="Identifier">function</span><span class="PreProc"> on_cursor_follow_playback_changed</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L12" class="LineNr"> 12 </span><span class="Comment">// called when &quot;cursor follow playback&quot; state is changed.</span>
<span id="L13" class="LineNr"> 13 </span><span class="Comment">// state: boolean. reflect current &quot;cursor follow playback&quot;  value.</span>
<span id="L14" class="LineNr"> 14 </span>
<span id="L15" class="LineNr"> 15 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_drop</span><span class="Statement">(</span><span class="Special">action</span><span class="Statement">,</span><span class="Special"> x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L16" class="LineNr"> 16 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_enter</span><span class="Statement">(</span><span class="Special">action</span><span class="Statement">,</span><span class="Special"> x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L17" class="LineNr"> 17 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_leave</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L18" class="LineNr"> 18 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_over</span><span class="Statement">(</span><span class="Special">action</span><span class="Statement">,</span><span class="Special"> x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L19" class="LineNr"> 19 </span><span class="Comment">// for on_drag_* callbacks, @feature &quot;dragdrop&quot; must be set in the preprocessor section.</span>
<span id="L20" class="LineNr"> 20 </span><span class="Comment">// see preprocessors.txt for more details.</span>
<span id="L21" class="LineNr"> 21 </span><span class="Comment">// see samples\Drag Drop Basic.txt for how to use &quot;action&quot;.</span>
<span id="L22" class="LineNr"> 22 </span>
<span id="L23" class="LineNr"> 23 </span><span class="Identifier">function</span><span class="PreProc"> on_focus</span><span class="Statement">(</span><span class="Special">is_focused</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L24" class="LineNr"> 24 </span><span class="Comment">// called when the panel gets/loses focus</span>
<span id="L25" class="LineNr"> 25 </span>
<span id="L26" class="LineNr"> 26 </span><span class="Identifier">function</span><span class="PreProc"> on_font_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L27" class="LineNr"> 27 </span><span class="Comment">// called when colours are changed via default UI/columns UI preferences</span>
<span id="L28" class="LineNr"> 28 </span><span class="Comment">// retrieve fonts using window.GetFontDUI()/window.GetFontCUI()</span>
<span id="L29" class="LineNr"> 29 </span>
<span id="L30" class="LineNr"> 30 </span><span class="Identifier">function</span><span class="PreProc"> on_get_album_art_done</span><span class="Statement">(</span><span class="Special">handle</span><span class="Statement">,</span><span class="Special"> art_id</span><span class="Statement">,</span><span class="Special"> image</span><span class="Statement">,</span><span class="Special"> image_path</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L31" class="LineNr"> 31 </span><span class="Comment">// called when thread created by utils.GetAlbumArtAsync() is done.</span>
<span id="L32" class="LineNr"> 32 </span><span class="Comment">// image_path will point to the image file (or music file if image is embedded).</span>
<span id="L33" class="LineNr"> 33 </span>
<span id="L34" class="LineNr"> 34 </span><span class="Identifier">function</span><span class="PreProc"> on_item_focus_change</span><span class="Statement">(</span><span class="Special">playlistIndex</span><span class="Statement">,</span><span class="Special"> from</span><span class="Statement">,</span><span class="Special"> to</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L35" class="LineNr"> 35 </span><span class="Comment">// called when playlist focus has been changed</span>
<span id="L36" class="LineNr"> 36 </span>
<span id="L37" class="LineNr"> 37 </span><span class="Identifier">function</span><span class="PreProc"> on_item_played</span><span class="Statement">(</span><span class="Special">handle</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L38" class="LineNr"> 38 </span><span class="Comment">// called when at least 60s of the track has been played or the track has reached </span>
<span id="L39" class="LineNr"> 39 </span><span class="Comment">// its end after at least 1/3 of it has been played through.</span>
<span id="L40" class="LineNr"> 40 </span>
<span id="L41" class="LineNr"> 41 </span><span class="Identifier">function</span><span class="PreProc"> on_key_down</span><span class="Statement">(</span><span class="Special">vkey</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L42" class="LineNr"> 42 </span><span class="Identifier">function</span><span class="PreProc"> on_key_up</span><span class="Statement">(</span><span class="Special">vkey</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L43" class="LineNr"> 43 </span><span class="Comment">// both keyboard related callbacks require &quot;Grab focus&quot; enabled in the Configuration window.</span>
<span id="L44" class="LineNr"> 44 </span><span class="Comment">// in order to use arrow keys, use window.DlgCode(DLGC_WANTARROWS);</span>
<span id="L45" class="LineNr"> 45 </span><span class="Comment">// see flags.txt &gt; DLGC_WANTARROWS.</span>
<span id="L46" class="LineNr"> 46 </span><span class="Comment">// you must return true to suppress processing keyboard shortcuts</span>
<span id="L47" class="LineNr"> 47 </span><span class="Comment">// vkey: Virtual Key Code, refer to: <a href="http://msdn.microsoft.com/en-us/library/ms927178.aspx">http://msdn.microsoft.com/en-us/library/ms927178.aspx</a></span>
<span id="L48" class="LineNr"> 48 </span>
<span id="L49" class="LineNr"> 49 </span><span class="Identifier">function</span><span class="PreProc"> on_library_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L50" class="LineNr"> 50 </span>
<span id="L51" class="LineNr"> 51 </span><span class="Identifier">function</span><span class="PreProc"> on_load_image_done</span><span class="Statement">(</span><span class="Special">cookie</span><span class="Statement">,</span><span class="Special"> image</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L52" class="LineNr"> 52 </span><span class="Comment">// called when thread created by gdi.LoadImageAsync() is done.</span>
<span id="L53" class="LineNr"> 53 </span>
<span id="L54" class="LineNr"> 54 </span><span class="Identifier">function</span><span class="PreProc"> on_metadb_changed</span><span class="Statement">(</span><span class="Special">handle_list</span><span class="Statement">,</span><span class="Special"> fromhook</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L55" class="LineNr"> 55 </span><span class="Comment">// called when metadb contents change.</span>
<span id="L56" class="LineNr"> 56 </span><span class="Comment">// see samples\Watch Metadb Change.txt</span>
<span id="L57" class="LineNr"> 57 </span>
<span id="L58" class="LineNr"> 58 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_lbtn_dblclk</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L59" class="LineNr"> 59 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_lbtn_down</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L60" class="LineNr"> 60 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_lbtn_up</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L61" class="LineNr"> 61 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_leave</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L62" class="LineNr"> 62 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_mbtn_dblclk</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L63" class="LineNr"> 63 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_mbtn_down</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L64" class="LineNr"> 64 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_mbtn_up</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L65" class="LineNr"> 65 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_move</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L66" class="LineNr"> 66 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_rbtn_dblclk</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L67" class="LineNr"> 67 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_rbtn_down</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L68" class="LineNr"> 68 </span><span class="Comment">// see flags.txt &gt; Mask for mouse callbacks</span>
<span id="L69" class="LineNr"> 69 </span>
<span id="L70" class="LineNr"> 70 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_rbtn_up</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L71" class="LineNr"> 71 </span><span class="Comment">// you must return true if you want to suppress the default context menu.</span>
<span id="L72" class="LineNr"> 72 </span><span class="Comment">// hold left shift + left windows key to bypass user code and open default context menu.</span>
<span id="L73" class="LineNr"> 73 </span>
<span id="L74" class="LineNr"> 74 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_wheel</span><span class="Statement">(</span><span class="Special">step</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L75" class="LineNr"> 75 </span>
<span id="L76" class="LineNr"> 76 </span><span class="Identifier">function</span><span class="PreProc"> on_notify_data</span><span class="Statement">(</span><span class="Special">name</span><span class="Statement">,</span><span class="Special"> info</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L77" class="LineNr"> 77 </span><span class="Comment">// called in other panels after window.NotifyOthers(name, info) is executed</span>
<span id="L78" class="LineNr"> 78 </span>
<span id="L79" class="LineNr"> 79 </span><span class="Identifier">function</span><span class="PreProc"> on_paint</span><span class="Statement">(</span><span class="Special">gr</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L80" class="LineNr"> 80 </span><span class="Comment">// called when window is ready to draw</span>
<span id="L81" class="LineNr"> 81 </span><span class="Comment">// see interfaces.txt for all the methods used with gr</span>
<span id="L82" class="LineNr"> 82 </span>
<span id="L83" class="LineNr"> 83 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_follow_cursor_changed</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L84" class="LineNr"> 84 </span><span class="Comment">// called when &quot;playback follow cursor&quot; state is changed</span>
<span id="L85" class="LineNr"> 85 </span><span class="Comment">// state: boolean, reflect current &quot;playback follow cursor&quot; value</span>
<span id="L86" class="LineNr"> 86 </span>
<span id="L87" class="LineNr"> 87 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_dynamic_info</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L88" class="LineNr"> 88 </span><span class="Comment">// dynamic info (VBR bitrate etc) change.</span>
<span id="L89" class="LineNr"> 89 </span>
<span id="L90" class="LineNr"> 90 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_dynamic_info_track</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L91" class="LineNr"> 91 </span><span class="Comment">// per-track dynamic info (stream track titles etc) change.</span>
<span id="L92" class="LineNr"> 92 </span><span class="Comment">// happens less often than on_playback_dynamic_info().</span>
<span id="L93" class="LineNr"> 93 </span>
<span id="L94" class="LineNr"> 94 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_edited</span><span class="Statement">(</span><span class="Special">handle</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L95" class="LineNr"> 95 </span><span class="Comment">// called when currently playing file gets edited.</span>
<span id="L96" class="LineNr"> 96 </span>
<span id="L97" class="LineNr"> 97 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_new_track</span><span class="Statement">(</span><span class="Special">handle</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L98" class="LineNr"> 98 </span>
<span id="L99" class="LineNr"> 99 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_order_changed</span><span class="Statement">(</span><span class="Special">new_order_index</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L100" class="LineNr">100 </span><span class="Comment">// called when playback order is changed</span>
<span id="L101" class="LineNr">101 </span><span class="Comment">// new_order_index:</span>
<span id="L102" class="LineNr">102 </span><span class="Comment">// 0 Default</span>
<span id="L103" class="LineNr">103 </span><span class="Comment">// 1 Repeat (Playlist)</span>
<span id="L104" class="LineNr">104 </span><span class="Comment">// 2 Repeat (Track)</span>
<span id="L105" class="LineNr">105 </span><span class="Comment">// 3 Random</span>
<span id="L106" class="LineNr">106 </span><span class="Comment">// 4 Shuffle (tracks)</span>
<span id="L107" class="LineNr">107 </span><span class="Comment">// 5 Shuffle (albums)</span>
<span id="L108" class="LineNr">108 </span><span class="Comment">// 6 Shuffle (folders)</span>
<span id="L109" class="LineNr">109 </span>
<span id="L110" class="LineNr">110 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_pause</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L111" class="LineNr">111 </span><span class="Comment">// state: true when paused, false when unpaused.</span>
<span id="L112" class="LineNr">112 </span>
<span id="L113" class="LineNr">113 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_queue_changed</span><span class="Statement">(</span><span class="Special">origin</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L114" class="LineNr">114 </span><span class="Comment">// origin: 0 user_added, 1 user_removed, 2 playback advance</span>
<span id="L115" class="LineNr">115 </span>
<span id="L116" class="LineNr">116 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_seek</span><span class="Statement">(</span><span class="Special">time</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L117" class="LineNr">117 </span><span class="Comment">// time: float value, in seconds.</span>
<span id="L118" class="LineNr">118 </span>
<span id="L119" class="LineNr">119 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_starting</span><span class="Statement">(</span><span class="Special">cmd</span><span class="Statement">,</span><span class="Special"> is_paused</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L120" class="LineNr">120 </span><span class="Comment">// cmd: 0 default, 1 play, 2 next, 3 prev, 4 settrack, 5 rand, 6 resume.</span>
<span id="L121" class="LineNr">121 </span>
<span id="L122" class="LineNr">122 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_stop</span><span class="Statement">(</span><span class="Special">reason</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L123" class="LineNr">123 </span><span class="Comment">// reason: 0 user, 1 eof, 2 starting_another.</span>
<span id="L124" class="LineNr">124 </span>
<span id="L125" class="LineNr">125 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_stop_after_current_changed</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L126" class="LineNr">126 </span><span class="Comment">// called when &quot;stop after current&quot; is enabled/disabled.</span>
<span id="L127" class="LineNr">127 </span><span class="Comment">// state: &quot;stop after current&quot; value, either true or false.</span>
<span id="L128" class="LineNr">128 </span>
<span id="L129" class="LineNr">129 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_time</span><span class="Statement">(</span><span class="Special">time</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L130" class="LineNr">130 </span><span class="Comment">// called every second, for time display.</span>
<span id="L131" class="LineNr">131 </span><span class="Comment">// time - float value, in sec.</span>
<span id="L132" class="LineNr">132 </span>
<span id="L133" class="LineNr">133 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_added</span><span class="Statement">(</span><span class="Special">playlistIndex</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L134" class="LineNr">134 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_item_ensure_visible</span><span class="Statement">(</span><span class="Special">playlistIndex</span><span class="Statement">,</span><span class="Special"> item</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L135" class="LineNr">135 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_removed</span><span class="Statement">(</span><span class="Special">playlistIndex</span><span class="Statement">,</span><span class="Special"> new_count</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L136" class="LineNr">136 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_reordered</span><span class="Statement">(</span><span class="Special">playlistIndex</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L137" class="LineNr">137 </span>
<span id="L138" class="LineNr">138 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_selection_change</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L139" class="LineNr">139 </span><span class="Comment">// workaround for some 3rd party playlist viewers not working with on_selection_changed()</span>
<span id="L140" class="LineNr">140 </span>
<span id="L141" class="LineNr">141 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_switch</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L142" class="LineNr">142 </span><span class="Identifier">function</span><span class="PreProc"> on_playlists_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L143" class="LineNr">143 </span>
<span id="L144" class="LineNr">144 </span><span class="Identifier">function</span><span class="PreProc"> on_refresh_background_done</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L145" class="LineNr">145 </span><span class="Comment">// Always call window.GetBackgroundImage() during this callback.</span>
<span id="L146" class="LineNr">146 </span><span class="Comment">// IMPORTANT: DO NOT call window.Repaint()</span>
<span id="L147" class="LineNr">147 </span>
<span id="L148" class="LineNr">148 </span><span class="Identifier">function</span><span class="PreProc"> on_script_unload</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L149" class="LineNr">149 </span><span class="Comment">// This callback is not guaranteed to be called during unloading.</span>
<span id="L150" class="LineNr">150 </span>
<span id="L151" class="LineNr">151 </span><span class="Identifier">function</span><span class="PreProc"> on_selection_changed</span><span class="Statement">(</span><span class="Special">handle</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L152" class="LineNr">152 </span><span class="Comment">/*</span>
<span id="L153" class="LineNr">153 </span><span class="Comment">called when selection changes based on &quot;File&gt;Preferences&gt;Display&gt;Selection viewers&quot;.</span>
<span id="L154" class="LineNr">154 </span><span class="Comment">handle may be undefined depending on which playlist viewer was used to update selection.</span>
<span id="L155" class="LineNr">155 </span><span class="Comment">if you need the handle, consider using something like this inside the callback:</span>
<span id="L156" class="LineNr">156 </span><span class="Comment">var handle = fb.GetSelection();</span>
<span id="L157" class="LineNr">157 </span><span class="Comment">*/</span>
<span id="L158" class="LineNr">158 </span>
<span id="L159" class="LineNr">159 </span><span class="Identifier">function</span><span class="PreProc"> on_size</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L160" class="LineNr">160 </span><span class="Comment">// called when panel is resized.</span>
<span id="L161" class="LineNr">161 </span><span class="Comment">// IMPORTANT: DO NOT call window.Repaint()</span>
<span id="L162" class="LineNr">162 </span>
<span id="L163" class="LineNr">163 </span><span class="Identifier">function</span><span class="PreProc"> on_volume_change</span><span class="Statement">(</span><span class="Special">val</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L164" class="LineNr">164 </span><span class="Comment">// val: volume level in dB. minimum is -100. maximum is 0.</span>
<span id="L165" class="LineNr">165 </span>
<span id="L166" class="LineNr">166 </span><span class="Comment">// Callback function prototypes</span>
<span id="L167" class="LineNr">167 </span>
<span id="L168" class="LineNr">168 </span><span class="Comment">// [1.0.4] Updated: mask, see Flags.txt for more details</span>
<span id="L169" class="LineNr">169 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_lbtn_down</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L170" class="LineNr">170 </span>
<span id="L171" class="LineNr">171 </span><span class="Comment">// [1.0.4] Updated: mask, see Flags.txt for more details</span>
<span id="L172" class="LineNr">172 </span><span class="Comment">// [1.3.6] NOTE: This callback will be suppressed while both VK_LSHIFT and VK_LWIN are pressed.</span>
<span id="L173" class="LineNr">173 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_lbtn_up</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L174" class="LineNr">174 </span>
<span id="L175" class="LineNr">175 </span><span class="Comment">// [1.1.8] Added: mask, see Flags.txt for more details</span>
<span id="L176" class="LineNr">176 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_lbtn_dblclk</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L177" class="LineNr">177 </span>
<span id="L178" class="LineNr">178 </span><span class="Comment">// [1.0.4] New:</span>
<span id="L179" class="LineNr">179 </span><span class="Comment">// mask, see Flags.txt for more details</span>
<span id="L180" class="LineNr">180 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_rbtn_down</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L181" class="LineNr">181 </span>
<span id="L182" class="LineNr">182 </span><span class="Comment">// [1.0.4] New:</span>
<span id="L183" class="LineNr">183 </span><span class="Comment">// mask, see Flags.txt for more details</span>
<span id="L184" class="LineNr">184 </span><span class="Comment">// HINT: return true if you want to supress the default context menu.</span>
<span id="L185" class="LineNr">185 </span><span class="Comment">// NOTE: {L-Win}+{L-Shift}+{Right Click} is reserved for poping up the default context menu.</span>
<span id="L186" class="LineNr">186 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_rbtn_up</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L187" class="LineNr">187 </span>
<span id="L188" class="LineNr">188 </span><span class="Comment">// [1.1.8] New:</span>
<span id="L189" class="LineNr">189 </span><span class="Comment">// mask, see Flags.txt for more details</span>
<span id="L190" class="LineNr">190 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_rbtn_dblclk</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L191" class="LineNr">191 </span>
<span id="L192" class="LineNr">192 </span><span class="Comment">// [1.1.8] New:</span>
<span id="L193" class="LineNr">193 </span><span class="Comment">// mask, see Flags.txt for more details</span>
<span id="L194" class="LineNr">194 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_mbtn_down</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L195" class="LineNr">195 </span>
<span id="L196" class="LineNr">196 </span><span class="Comment">// [1.1.8] New:</span>
<span id="L197" class="LineNr">197 </span><span class="Comment">// mask, see Flags.txt for more details</span>
<span id="L198" class="LineNr">198 </span><span class="Comment">// Actions should be executed in this callback</span>
<span id="L199" class="LineNr">199 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_mbtn_up</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L200" class="LineNr">200 </span>
<span id="L201" class="LineNr">201 </span><span class="Comment">// [1.1.8] New:</span>
<span id="L202" class="LineNr">202 </span><span class="Comment">// mask, see Flags.txt for more details</span>
<span id="L203" class="LineNr">203 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_mbtn_dblclk</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L204" class="LineNr">204 </span>
<span id="L205" class="LineNr">205 </span><span class="Comment">// [1.4.1] Updated:</span>
<span id="L206" class="LineNr">206 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_move</span><span class="Statement">(</span><span class="Special">x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L207" class="LineNr">207 </span>
<span id="L208" class="LineNr">208 </span><span class="Comment">// Called when mouse leaves WSH Panel Mod</span>
<span id="L209" class="LineNr">209 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_leave</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L210" class="LineNr">210 </span>
<span id="L211" class="LineNr">211 </span><span class="Identifier">function</span><span class="PreProc"> on_mouse_wheel</span><span class="Statement">(</span><span class="Special">step</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L212" class="LineNr">212 </span>
<span id="L213" class="LineNr">213 </span><span class="Comment">/* </span>
<span id="L214" class="LineNr">214 </span><span class="Comment"> * NOTE: All keyboard related callbacks require &quot;Grab focus&quot; enabled in panel Properties.</span>
<span id="L215" class="LineNr">215 </span><span class="Comment"> *       To capture arrow keys, set window.DlgCode</span>
<span id="L216" class="LineNr">216 </span><span class="Comment"> */</span>
<span id="L217" class="LineNr">217 </span>
<span id="L218" class="LineNr">218 </span><span class="Comment">// Keyboard key down</span>
<span id="L219" class="LineNr">219 </span><span class="Comment">// HINT: Return true to suppress processing keyboard shortcuts</span>
<span id="L220" class="LineNr">220 </span><span class="Comment">// vkey: Virtual Key Code, Refer to: <a href="http://msdn.microsoft.com/en-us/library/ms927178.aspx">http://msdn.microsoft.com/en-us/library/ms927178.aspx</a></span>
<span id="L221" class="LineNr">221 </span><span class="Identifier">function</span><span class="PreProc"> on_key_down</span><span class="Statement">(</span><span class="Special">vkey</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L222" class="LineNr">222 </span>
<span id="L223" class="LineNr">223 </span><span class="Comment">// [1.3.2] New:</span>
<span id="L224" class="LineNr">224 </span><span class="Comment">// Keyboard key up</span>
<span id="L225" class="LineNr">225 </span><span class="Comment">// vkey: Virtual Key Code, Refer to: <a href="http://msdn.microsoft.com/en-us/library/ms927178.aspx">http://msdn.microsoft.com/en-us/library/ms927178.aspx</a></span>
<span id="L226" class="LineNr">226 </span><span class="Identifier">function</span><span class="PreProc"> on_key_up</span><span class="Statement">(</span><span class="Special">vkey</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L227" class="LineNr">227 </span>
<span id="L228" class="LineNr">228 </span><span class="Comment">// [1.3.2] New:</span>
<span id="L229" class="LineNr">229 </span><span class="Comment">// code: UTF16 encoded char.</span>
<span id="L230" class="LineNr">230 </span><span class="Comment">// NOTE: in order to use this callback, set flag DLGC_WANTCHARS (#Flags.txt) to window.DlgCode.</span>
<span id="L231" class="LineNr">231 </span><span class="Identifier">function</span><span class="PreProc"> on_char</span><span class="Statement">(</span><span class="Special">code</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L232" class="LineNr">232 </span>
<span id="L233" class="LineNr">233 </span><span class="Comment">// Get or lost focus</span>
<span id="L234" class="LineNr">234 </span><span class="Identifier">function</span><span class="PreProc"> on_focus</span><span class="Statement">(</span><span class="Special">is_focused</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L235" class="LineNr">235 </span>
<span id="L236" class="LineNr">236 </span><span class="Comment">// After window is sized</span>
<span id="L237" class="LineNr">237 </span><span class="Comment">// NOTE: DO NOT Call window.Repaint() and such to repaint window in this function</span>
<span id="L238" class="LineNr">238 </span><span class="Identifier">function</span><span class="PreProc"> on_size</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L239" class="LineNr">239 </span>
<span id="L240" class="LineNr">240 </span><span class="Comment">// Called when window is ready to draw</span>
<span id="L241" class="LineNr">241 </span><span class="Comment">// gr - Refer to IGdiGraphics, note that gr will be invalid out of this callback scope.</span>
<span id="L242" class="LineNr">242 </span><span class="Identifier">function</span><span class="PreProc"> on_paint</span><span class="Statement">(</span><span class="Special">gr</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L243" class="LineNr">243 </span>
<span id="L244" class="LineNr">244 </span><span class="Comment">// [1.1.1] New: Called when &quot;stop after current&quot; state is changed</span>
<span id="L245" class="LineNr">245 </span><span class="Comment">// state: boolean, reflect current &quot;stop after current&quot; value</span>
<span id="L246" class="LineNr">246 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_stop_after_current_changed</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L247" class="LineNr">247 </span>
<span id="L248" class="LineNr">248 </span><span class="Comment">// [1.1.1] New: Called when &quot;cursor follow playback&quot; state is changed</span>
<span id="L249" class="LineNr">249 </span><span class="Comment">// state: boolean, reflect current &quot;cursor follow playback&quot;  value</span>
<span id="L250" class="LineNr">250 </span><span class="Identifier">function</span><span class="PreProc"> on_cursor_follow_playback_changed</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L251" class="LineNr">251 </span>
<span id="L252" class="LineNr">252 </span><span class="Comment">// [1.1.1] New: Called when &quot;playback follow cursor&quot; state is changed</span>
<span id="L253" class="LineNr">253 </span><span class="Comment">// state: boolean, reflect current &quot;playback follow cursor&quot; value</span>
<span id="L254" class="LineNr">254 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_follow_cursor_changed</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L255" class="LineNr">255 </span>
<span id="L256" class="LineNr">256 </span><span class="Comment">// [1.1.1] New: Called in other panels after window.NotifyOthers(name, info) is executed</span>
<span id="L257" class="LineNr">257 </span><span class="Comment">// name and info is the same as in NotifyOthers()</span>
<span id="L258" class="LineNr">258 </span><span class="Comment">// [1.3.0] Updated, see Interfaces.txt for more details.</span>
<span id="L259" class="LineNr">259 </span><span class="Identifier">function</span><span class="PreProc"> on_notify_data</span><span class="Statement">(</span><span class="Special">name</span><span class="Statement">,</span><span class="Special"> info</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L260" class="LineNr">260 </span>
<span id="L261" class="LineNr">261 </span><span class="Comment">// [1.1.10] New:</span>
<span id="L262" class="LineNr">262 </span><span class="Comment">// [1.3.0] Updated:</span>
<span id="L263" class="LineNr">263 </span><span class="Comment">//   image_path will point to the image file (or music file itself, if image is an embedded image)</span>
<span id="L264" class="LineNr">264 </span><span class="Comment">// Get called while thread created by GetAlbumArtAsync() is done.</span>
<span id="L265" class="LineNr">265 </span><span class="Identifier">function</span><span class="PreProc"> on_get_album_art_done</span><span class="Statement">(</span><span class="Special">metadb</span><span class="Statement">,</span><span class="Special"> art_id</span><span class="Statement">,</span><span class="Special"> image</span><span class="Statement">,</span><span class="Special"> image_path</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L266" class="LineNr">266 </span>
<span id="L267" class="LineNr">267 </span><span class="Comment">// [1.3.2] New:</span>
<span id="L268" class="LineNr">268 </span><span class="Comment">// Get called while thread created by gdi.LoadImageAsync() is done.</span>
<span id="L269" class="LineNr">269 </span><span class="Identifier">function</span><span class="PreProc"> on_load_image_done</span><span class="Statement">(</span><span class="Special">cookie</span><span class="Statement">,</span><span class="Special"> image</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L270" class="LineNr">270 </span>
<span id="L271" class="LineNr">271 </span><span class="Comment">// [1.1.10] New: </span>
<span id="L272" class="LineNr">272 </span><span class="Comment">// NOTE 1: Always call window.GetBackgroundImage() during this callback</span>
<span id="L273" class="LineNr">273 </span><span class="Comment">// NOTE 2: DO NOT call window.Repaint()</span>
<span id="L274" class="LineNr">274 </span><span class="Identifier">function</span><span class="PreProc"> on_refresh_background_done</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L275" class="LineNr">275 </span>
<span id="L276" class="LineNr">276 </span><span class="Comment">// [1.1.10] New: </span>
<span id="L277" class="LineNr">277 </span><span class="Comment">// Called when at least 60s of the track has been played, or the track has reached its end after at least 1/3 </span>
<span id="L278" class="LineNr">278 </span><span class="Comment">//    of it has been played through.</span>
<span id="L279" class="LineNr">279 </span><span class="Identifier">function</span><span class="PreProc"> on_item_played</span><span class="Statement">(</span><span class="Special">metadb</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L280" class="LineNr">280 </span>
<span id="L281" class="LineNr">281 </span><span class="Comment">// cmd: (integer, begin with 0): default, play, next, prev, settrack, rand, resume</span>
<span id="L282" class="LineNr">282 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_starting</span><span class="Statement">(</span><span class="Special">cmd</span><span class="Statement">,</span><span class="Special"> is_paused</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L283" class="LineNr">283 </span>
<span id="L284" class="LineNr">284 </span><span class="Comment">// [1.1.0] Updated: metadb - Refer to IFbMetadbHandle</span>
<span id="L285" class="LineNr">285 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_new_track</span><span class="Statement">(</span><span class="Special">metadb</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L286" class="LineNr">286 </span>
<span id="L287" class="LineNr">287 </span><span class="Comment">// reason: (integer, begin with 0): user, eof, starting_another</span>
<span id="L288" class="LineNr">288 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_stop</span><span class="Statement">(</span><span class="Special">reason</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L289" class="LineNr">289 </span>
<span id="L290" class="LineNr">290 </span><span class="Comment">// time - float value, in seconds.</span>
<span id="L291" class="LineNr">291 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_seek</span><span class="Statement">(</span><span class="Special">time</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L292" class="LineNr">292 </span>
<span id="L293" class="LineNr">293 </span><span class="Comment">// state = true when paused, false when resumed</span>
<span id="L294" class="LineNr">294 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_pause</span><span class="Statement">(</span><span class="Special">state</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L295" class="LineNr">295 </span>
<span id="L296" class="LineNr">296 </span><span class="Comment">// [1.4.3] Updated:</span>
<span id="L297" class="LineNr">297 </span><span class="Comment">// Called when currently played file gets edited</span>
<span id="L298" class="LineNr">298 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_edited</span><span class="Statement">(</span><span class="Special">metadb</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L299" class="LineNr">299 </span>
<span id="L300" class="LineNr">300 </span><span class="Comment">// Dynamic info (VBR bitrate etc) change</span>
<span id="L301" class="LineNr">301 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_dynamic_info</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L302" class="LineNr">302 </span>
<span id="L303" class="LineNr">303 </span><span class="Comment">// Per-track dynamic info (stream track titles etc) change. Happens less often than on_playback_dynamic_info().</span>
<span id="L304" class="LineNr">304 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_dynamic_info_track</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L305" class="LineNr">305 </span>
<span id="L306" class="LineNr">306 </span><span class="Comment">// Called every second, for time display</span>
<span id="L307" class="LineNr">307 </span><span class="Comment">// time - float value, in sec</span>
<span id="L308" class="LineNr">308 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_time</span><span class="Statement">(</span><span class="Special">time</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L309" class="LineNr">309 </span>
<span id="L310" class="LineNr">310 </span><span class="Comment">// val - volume level in dB; 0 for full volume.</span>
<span id="L311" class="LineNr">311 </span><span class="Identifier">function</span><span class="PreProc"> on_volume_change</span><span class="Statement">(</span><span class="Special">val</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L312" class="LineNr">312 </span>
<span id="L313" class="LineNr">313 </span><span class="Comment">// NEW: Called when playback order is changed</span>
<span id="L314" class="LineNr">314 </span><span class="Comment">// new_order_index:</span>
<span id="L315" class="LineNr">315 </span><span class="Comment">//      0 - &quot;Default&quot;</span>
<span id="L316" class="LineNr">316 </span><span class="Comment">//      1 - &quot;Repeat (Playlist)&quot;</span>
<span id="L317" class="LineNr">317 </span><span class="Comment">//      2 - &quot;Repeat (Track)&quot;</span>
<span id="L318" class="LineNr">318 </span><span class="Comment">//      3 - &quot;Random&quot;</span>
<span id="L319" class="LineNr">319 </span><span class="Comment">//      4 - &quot;Shuffle (tracks)&quot;</span>
<span id="L320" class="LineNr">320 </span><span class="Comment">//      5 - &quot;Shuffle (albums)&quot;</span>
<span id="L321" class="LineNr">321 </span><span class="Comment">//      6 - &quot;Shuffle (folders)&quot;</span>
<span id="L322" class="LineNr">322 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_order_changed</span><span class="Statement">(</span><span class="Special">new_order_index</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L323" class="LineNr">323 </span>
<span id="L324" class="LineNr">324 </span><span class="Identifier">function</span><span class="PreProc"> on_timer</span><span class="Statement">(</span><span class="Special">timer_id</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L325" class="LineNr">325 </span>
<span id="L326" class="LineNr">326 </span><span class="Comment">// [1.1.1] Updated: Called when playlist focus has been changed</span>
<span id="L327" class="LineNr">327 </span><span class="Comment">// For those who what to implement &quot;follow cursor&quot;</span>
<span id="L328" class="LineNr">328 </span><span class="Comment">// [1.5.0 Preview 6]: Changed: Add callback parameters &quot;playlist&quot;, &quot;from&quot; and &quot;to&quot;</span>
<span id="L329" class="LineNr">329 </span><span class="Identifier">function</span><span class="PreProc"> on_item_focus_change</span><span class="Statement">(</span><span class="Special">playlist</span><span class="Statement">,</span><span class="Special"> from</span><span class="Statement">,</span><span class="Special"> to</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L330" class="LineNr">330 </span>
<span id="L331" class="LineNr">331 </span><span class="Comment">// [1.1.3] New:</span>
<span id="L332" class="LineNr">332 </span><span class="Comment">// [1.4.0] Changed:</span>
<span id="L333" class="LineNr">333 </span><span class="Comment">// Called when metadb contents change. (Or, one of display hook component requests display update).</span>
<span id="L334" class="LineNr">334 </span><span class="Comment">// Cooperated with window.WatchMetadb() and window.UnWatchMetadb()</span>
<span id="L335" class="LineNr">335 </span><span class="Comment">// metadb_or_metadbs: </span>
<span id="L336" class="LineNr">336 </span><span class="Comment">//          prior to &quot;v1.4.0&quot;   - The same metadb as in window.WatchMetadb(metadb)</span>
<span id="L337" class="LineNr">337 </span><span class="Comment">//          &quot;v1.4.0&quot;            - Metadb handles</span>
<span id="L338" class="LineNr">338 </span><span class="Comment">// fromhook: boolean, set to true when actual file contents haven't changed but one of metadb_display_field_provider </span>
<span id="L339" class="LineNr">339 </span><span class="Comment">//   implementations requested an update so output of metadb_handle::format_title() etc has changed.</span>
<span id="L340" class="LineNr">340 </span><span class="Comment">// NOTE: See Preprocessors.txt if you are using @feature directive.</span>
<span id="L341" class="LineNr">341 </span><span class="Comment">// NOTE: metadb will be metadb handle list (already sorted) when preprocessor directive &quot;feature&quot;:</span>
<span id="L342" class="LineNr">342 </span><span class="Comment">//   1. &quot;v1.4&quot; and later is set;</span>
<span id="L343" class="LineNr">343 </span><span class="Comment">//   2. &quot;watch-metadb&quot; is set.</span>
<span id="L344" class="LineNr">344 </span><span class="Identifier">function</span><span class="PreProc"> on_metadb_changed</span><span class="Statement">(</span><span class="Special">metadb_or_metadbs</span><span class="Statement">,</span><span class="Special"> fromhook</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L345" class="LineNr">345 </span>
<span id="L346" class="LineNr">346 </span><span class="Comment">// [1.3.0] New:</span>
<span id="L347" class="LineNr">347 </span><span class="Comment">// DUI and CUI</span>
<span id="L348" class="LineNr">348 </span><span class="Comment">// On color setting changed</span>
<span id="L349" class="LineNr">349 </span><span class="Comment">// Retrieve colors using window.GetColorXXX() method.</span>
<span id="L350" class="LineNr">350 </span><span class="Identifier">function</span><span class="PreProc"> on_colors_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L351" class="LineNr">351 </span>
<span id="L352" class="LineNr">352 </span><span class="Comment">// [1.3.0] New:</span>
<span id="L353" class="LineNr">353 </span><span class="Comment">// DUI and CUI</span>
<span id="L354" class="LineNr">354 </span><span class="Comment">// On font setting changed</span>
<span id="L355" class="LineNr">355 </span><span class="Comment">// Retrieve fonts using window.GetFontXXX() method.</span>
<span id="L356" class="LineNr">356 </span><span class="Identifier">function</span><span class="PreProc"> on_font_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L357" class="LineNr">357 </span>
<span id="L358" class="LineNr">358 </span><span class="Comment">// [1.3.0] New:</span>
<span id="L359" class="LineNr">359 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_switch</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L360" class="LineNr">360 </span>
<span id="L361" class="LineNr">361 </span><span class="Comment">// [1.3.0] New:</span>
<span id="L362" class="LineNr">362 </span><span class="Comment">// Note: this callback is not guarantee to be called during unloading</span>
<span id="L363" class="LineNr">363 </span><span class="Identifier">function</span><span class="PreProc"> on_script_unload</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L364" class="LineNr">364 </span>
<span id="L365" class="LineNr">365 </span><span class="Comment">// [1.3.2] New:</span>
<span id="L366" class="LineNr">366 </span><span class="Comment">// Called when any playlist is removed/reordered/created/renamed.</span>
<span id="L367" class="LineNr">367 </span><span class="Identifier">function</span><span class="PreProc"> on_playlists_changed</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L368" class="LineNr">368 </span>
<span id="L369" class="LineNr">369 </span><span class="Comment">// [1.3.2] New:</span>
<span id="L370" class="LineNr">370 </span><span class="Comment">// [1.4.0 Beta 1] Changed:</span>
<span id="L371" class="LineNr">371 </span><span class="Comment">// This behavior will be changed when &quot;Display-&gt;Selection viewers&quot; of foobar2000 preferences is changed.</span>
<span id="L372" class="LineNr">372 </span><span class="Comment">// NOTE: metadb may be null.</span>
<span id="L373" class="LineNr">373 </span><span class="Comment">// NOTE: metadb will be not valid while preprocessor: &quot;feature&quot; is &quot;v1.4&quot; or newer. (See Preprocessors.txt)</span>
<span id="L374" class="LineNr">374 </span><span class="Identifier">function</span><span class="PreProc"> on_selection_changed</span><span class="Statement">(</span><span class="Special">metadb</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L375" class="LineNr">375 </span>
<span id="L376" class="LineNr">376 </span><span class="Comment">// [1.5.0 Preview 7] New:</span>
<span id="L377" class="LineNr">377 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_item_ensure_visible</span><span class="Statement">(</span><span class="Special">playlist</span><span class="Statement">,</span><span class="Special"> item</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L378" class="LineNr">378 </span>
<span id="L379" class="LineNr">379 </span><span class="Comment">// [1.4.1] Added:</span>
<span id="L380" class="LineNr">380 </span><span class="Comment">// playlist: index to indicate that which playlist has newly added items</span>
<span id="L381" class="LineNr">381 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_added</span><span class="Statement">(</span><span class="Special">playlist</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L382" class="LineNr">382 </span>
<span id="L383" class="LineNr">383 </span><span class="Comment">// [1.5.0 Preview] Added:</span>
<span id="L384" class="LineNr">384 </span><span class="Comment">// Note this callback is different from on_playlists_changed(), which is applied to playlists, whenever</span>
<span id="L385" class="LineNr">385 </span><span class="Comment">//   this applied to playlist items instead.</span>
<span id="L386" class="LineNr">386 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_reordered</span><span class="Statement">(</span><span class="Special">playlist</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L387" class="LineNr">387 </span>
<span id="L388" class="LineNr">388 </span><span class="Comment">// [1.4.1] Added:</span>
<span id="L389" class="LineNr">389 </span><span class="Comment">// playlist: index to indicate that which playlist has items removed</span>
<span id="L390" class="LineNr">390 </span><span class="Comment">// new_count: new items count of the playlist.</span>
<span id="L391" class="LineNr">391 </span><span class="Identifier">function</span><span class="PreProc"> on_playlist_items_removed</span><span class="Statement">(</span><span class="Special">playlist</span><span class="Statement">,</span><span class="Special"> new_count</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L392" class="LineNr">392 </span>
<span id="L393" class="LineNr">393 </span><span class="Comment">// [1.5.0] Added:</span>
<span id="L394" class="LineNr">394 </span><span class="Comment">// origin:  0 - changed_user_added</span>
<span id="L395" class="LineNr">395 </span><span class="Comment">//          1 - changed_user_removed</span>
<span id="L396" class="LineNr">396 </span><span class="Comment">//          2 - changed_playback_advance</span>
<span id="L397" class="LineNr">397 </span><span class="Identifier">function</span><span class="PreProc"> on_playback_queue_changed</span><span class="Statement">(</span><span class="Special">origin</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L398" class="LineNr">398 </span>
<span id="L399" class="LineNr">399 </span><span class="Comment">/* </span>
<span id="L400" class="LineNr">400 </span><span class="Comment"> * Note:</span>
<span id="L401" class="LineNr">401 </span><span class="Comment"> * In order to get drag and drop callbacks work, you have to set feature=&quot;dragdrop&quot; in the preprocessor.</span>
<span id="L402" class="LineNr">402 </span><span class="Comment"> * See Preprocessors.txt for more details.</span>
<span id="L403" class="LineNr">403 </span><span class="Comment"> *</span>
<span id="L404" class="LineNr">404 </span><span class="Comment"> * While dragging, you cannot receive callbacks like on_mouse_move().</span>
<span id="L405" class="LineNr">405 </span><span class="Comment"> */</span>
<span id="L406" class="LineNr">406 </span>
<span id="L407" class="LineNr">407 </span><span class="Comment">// [1.4.1] Added:</span>
<span id="L408" class="LineNr">408 </span><span class="Comment">// x, y and mask have the same meaning as in on_mouse_*() callbacks.</span>
<span id="L409" class="LineNr">409 </span><span class="Comment">// action: an object of IDropTargetAction interface.</span>
<span id="L410" class="LineNr">410 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_enter</span><span class="Statement">(</span><span class="Special">action</span><span class="Statement">,</span><span class="Special"> x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L411" class="LineNr">411 </span>
<span id="L412" class="LineNr">412 </span><span class="Comment">// [1.4.1] Added:</span>
<span id="L413" class="LineNr">413 </span><span class="Comment">// x, y and mask have the same meaning as in on_mouse_*() callbacks.</span>
<span id="L414" class="LineNr">414 </span><span class="Comment">// action: an object of IDropTargetAction interface.</span>
<span id="L415" class="LineNr">415 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_over</span><span class="Statement">(</span><span class="Special">action</span><span class="Statement">,</span><span class="Special"> x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L416" class="LineNr">416 </span>
<span id="L417" class="LineNr">417 </span><span class="Comment">// [1.4.1] Added:</span>
<span id="L418" class="LineNr">418 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_leave</span><span class="Statement">()</span> <span class="Identifier">{}</span>
<span id="L419" class="LineNr">419 </span>
<span id="L420" class="LineNr">420 </span><span class="Comment">// [1.4.1] Added:</span>
<span id="L421" class="LineNr">421 </span><span class="Comment">// x, y and mask have the same meaning as in on_mouse_*() callbacks.</span>
<span id="L422" class="LineNr">422 </span><span class="Comment">// action: an object of IDropTargetAction interface.</span>
<span id="L423" class="LineNr">423 </span><span class="Identifier">function</span><span class="PreProc"> on_drag_drop</span><span class="Statement">(</span><span class="Special">action</span><span class="Statement">,</span><span class="Special"> x</span><span class="Statement">,</span><span class="Special"> y</span><span class="Statement">,</span><span class="Special"> mask</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L424" class="LineNr">424 </span>
<span id="L425" class="LineNr">425 </span>
<span id="L426" class="LineNr">426 </span><span class="Comment">// [1.5.0 Preview 8] New:</span>
<span id="L427" class="LineNr">427 </span><span class="Comment">// gr - Refer to IGdiGraphics, note that gr will be invalid out of this callback scope.</span>
<span id="L428" class="LineNr">428 </span><span class="Comment">// Please check your &quot;tooltip&quot; preprocessor directive before use.</span>
<span id="L429" class="LineNr">429 </span><span class="Identifier">function</span><span class="PreProc"> on_tooltip_custom_paint</span><span class="Statement">(</span><span class="Special">gr</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L430" class="LineNr">430 </span>
<span id="L431" class="LineNr">431 </span><span class="Comment">// [Plus 1.5.6] New:</span>
<span id="L432" class="LineNr">432 </span><span class="Comment">// metadbs: processed by `IFbPlaylistManager ProcessLocationsAsync(urls)'</span>
<span id="L433" class="LineNr">433 </span><span class="Identifier">function</span><span class="PreProc"> on_process_locations_done</span><span class="Statement">(</span><span class="Special">metadbs</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L434" class="LineNr">434 </span>
<span id="L435" class="LineNr">435 </span><span class="Comment">// [Plus 1.5.6] New:</span>
<span id="L436" class="LineNr">436 </span><span class="Comment">// cookie: int </span>
<span id="L437" class="LineNr">437 </span><span class="Comment">// `IhttpRequest RunAsync(window_id, url)' will returns a cookie</span>
<span id="L438" class="LineNr">438 </span><span class="Identifier">function</span><span class="PreProc"> on_http_run_done</span><span class="Statement">(</span><span class="Special">cookie</span><span class="Statement">,</span><span class="Special"> string</span><span class="Statement">)</span> <span class="Identifier">{}</span>
<span id="L439" class="LineNr">439 </span>
<span id="L440" class="LineNr">440 </span>
<span id="L441" class="LineNr">441 </span><span class="Comment">// [Plus 1.5.7.4] New</span>
<span id="L442" class="LineNr">442 </span><span class="Comment">// param - info = IHttpRequestExCallbackInfo object</span>
<span id="L443" class="LineNr">443 </span><span class="Identifier">function</span><span class="PreProc"> on_http_ex_run_status</span><span class="Statement">(</span><span class="Special">info</span><span class="Statement">)</span><span class="Identifier">{}</span>
<span id="L444" class="LineNr">444 </span>
<span id="L445" class="LineNr">445 </span>
<span id="L446" class="LineNr">446 </span><span class="Comment">// [Plus 1.5.7] New</span>
<span id="L447" class="LineNr">447 </span><span class="Comment">// Do someting when items in library added/removed/changed </span>
<span id="L448" class="LineNr">448 </span><span class="Identifier">function</span><span class="PreProc"> on_library_changed</span><span class="Statement">(</span><span class="Special">origin</span><span class="Statement">)</span> <span class="Identifier">{}</span><span class="Statement">;</span>
<span id="L449" class="LineNr">449 </span>
<span id="L450" class="LineNr">450 </span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->
